<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PxHeightFieldSample Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('structPxHeightFieldSample.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structPxHeightFieldSample-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">PxHeightFieldSample Struct Reference<div class="ingroups"><a class="el" href="group__geomutils.html">Geomutils</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Heightfield sample format.  
 <a href="structPxHeightFieldSample.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="PxHeightFieldSample_8h_source.html">PxHeightFieldSample.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for PxHeightFieldSample:</div>
<div class="dyncontent">
<div class="center"><img src="structPxHeightFieldSample__coll__graph.png" border="0" usemap="#PxHeightFieldSample_coll__map" alt="Collaboration graph"/></div>
<map name="PxHeightFieldSample_coll__map" id="PxHeightFieldSample_coll__map">
<area shape="rect" id="node2" href="classPxBitAndDataT.html" title="PxBitAndDataT\&lt; unsigned\l char, 0x80 \&gt;" alt="" coords="5,5,180,47"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:adb2f7899e79e9776965fe75cb5992bdc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#ga6e444d58dbf1459261fadc9b79594f63">PX_CUDA_CALLABLE</a> <a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> PxU8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxHeightFieldSample.html#adb2f7899e79e9776965fe75cb5992bdc">tessFlag</a> () const</td></tr>
<tr class="separator:adb2f7899e79e9776965fe75cb5992bdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82ee14c99624ff3ace22e8408eea9935"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#ga6e444d58dbf1459261fadc9b79594f63">PX_CUDA_CALLABLE</a> <a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxHeightFieldSample.html#a82ee14c99624ff3ace22e8408eea9935">setTessFlag</a> ()</td></tr>
<tr class="separator:a82ee14c99624ff3ace22e8408eea9935"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa28e24b4763400eb5bd84378a23e086f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#ga6e444d58dbf1459261fadc9b79594f63">PX_CUDA_CALLABLE</a> <a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxHeightFieldSample.html#aa28e24b4763400eb5bd84378a23e086f">clearTessFlag</a> ()</td></tr>
<tr class="separator:aa28e24b4763400eb5bd84378a23e086f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:acfdb9fa8a4f56b5c3354cd552768a026"><td class="memItemLeft" align="right" valign="top">PxI16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxHeightFieldSample.html#acfdb9fa8a4f56b5c3354cd552768a026">height</a></td></tr>
<tr class="memdesc:acfdb9fa8a4f56b5c3354cd552768a026"><td class="mdescLeft">&#160;</td><td class="mdescRight">The height of the heightfield sample.  <a href="#acfdb9fa8a4f56b5c3354cd552768a026">More...</a><br /></td></tr>
<tr class="separator:acfdb9fa8a4f56b5c3354cd552768a026"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ec426622c36188a3de6f295caed819f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#ga8c8d56ad8584332dc0d55c7936fb0af3">PxBitAndByte</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxHeightFieldSample.html#a6ec426622c36188a3de6f295caed819f">materialIndex0</a></td></tr>
<tr class="memdesc:a6ec426622c36188a3de6f295caed819f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The triangle material index of the quad's lower triangle + tesselation flag.  <a href="#a6ec426622c36188a3de6f295caed819f">More...</a><br /></td></tr>
<tr class="separator:a6ec426622c36188a3de6f295caed819f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae97419cbc1c9fdaa3f7f88fbe2298b1a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#ga8c8d56ad8584332dc0d55c7936fb0af3">PxBitAndByte</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxHeightFieldSample.html#ae97419cbc1c9fdaa3f7f88fbe2298b1a">materialIndex1</a></td></tr>
<tr class="memdesc:ae97419cbc1c9fdaa3f7f88fbe2298b1a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The triangle material index of the quad's upper triangle + reserved flag.  <a href="#ae97419cbc1c9fdaa3f7f88fbe2298b1a">More...</a><br /></td></tr>
<tr class="separator:ae97419cbc1c9fdaa3f7f88fbe2298b1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Heightfield sample format. </p>
<p>This format corresponds to the <a class="el" href="structPxHeightFieldFormat.html" title="Describes the format of height field samples. ">PxHeightFieldFormat</a> member <a class="el" href="structPxHeightFieldFormat.html#ad28e3afa439f8ff1df6067288c46d9c5aa8ba1edf74a561d830b5f40e2c3e64e7" title="Height field height data is 16 bit signed integers, followed by triangle materials. ">PxHeightFieldFormat::eS16_TM</a>.</p>
<p>An array of heightfield samples are used when creating a <a class="el" href="classPxHeightField.html" title="A height field class. ">PxHeightField</a> to specify the elevation of the heightfield points. In addition the material and tessellation of the adjacent triangles are specified.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxHeightField.html" title="A height field class. ">PxHeightField</a> <a class="el" href="classPxHeightFieldDesc.html" title="Descriptor class for PxHeightField. ">PxHeightFieldDesc</a> <a class="el" href="classPxHeightFieldDesc.html#affbec0b3ed43d041b12152648d13821b" title="The samples array. ">PxHeightFieldDesc.samples</a> </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aa28e24b4763400eb5bd84378a23e086f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa28e24b4763400eb5bd84378a23e086f">&#9670;&nbsp;</a></span>clearTessFlag()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#ga6e444d58dbf1459261fadc9b79594f63">PX_CUDA_CALLABLE</a> <a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> void PxHeightFieldSample::clearTessFlag </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="reference">References <a class="el" href="PxContact_8h.html#aacfae46ce7f6152c41b5bdacbceb862e">materialIndex0</a>.</p>

</div>
</div>
<a id="a82ee14c99624ff3ace22e8408eea9935"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82ee14c99624ff3ace22e8408eea9935">&#9670;&nbsp;</a></span>setTessFlag()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#ga6e444d58dbf1459261fadc9b79594f63">PX_CUDA_CALLABLE</a> <a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> void PxHeightFieldSample::setTessFlag </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="reference">References <a class="el" href="PxContact_8h.html#aacfae46ce7f6152c41b5bdacbceb862e">materialIndex0</a>.</p>

</div>
</div>
<a id="adb2f7899e79e9776965fe75cb5992bdc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb2f7899e79e9776965fe75cb5992bdc">&#9670;&nbsp;</a></span>tessFlag()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#ga6e444d58dbf1459261fadc9b79594f63">PX_CUDA_CALLABLE</a> <a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> PxU8 PxHeightFieldSample::tessFlag </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="reference">References <a class="el" href="PxContact_8h.html#aacfae46ce7f6152c41b5bdacbceb862e">materialIndex0</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="acfdb9fa8a4f56b5c3354cd552768a026"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acfdb9fa8a4f56b5c3354cd552768a026">&#9670;&nbsp;</a></span>height</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PxI16 PxHeightFieldSample::height</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The height of the heightfield sample. </p>
<p>This value is scaled by <a class="el" href="classPxHeightFieldGeometry.html#a8ced165e5b805d5e6c2b6a4fdc33ed2a" title="The scaling factor for the height field in vertical direction (y direction in local space)...">PxHeightFieldGeometry::heightScale</a>.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxHeightFieldGeometry.html" title="Height field geometry class. ">PxHeightFieldGeometry</a> </dd></dl>

</div>
</div>
<a id="a6ec426622c36188a3de6f295caed819f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ec426622c36188a3de6f295caed819f">&#9670;&nbsp;</a></span>materialIndex0</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#ga8c8d56ad8584332dc0d55c7936fb0af3">PxBitAndByte</a> PxHeightFieldSample::materialIndex0</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The triangle material index of the quad's lower triangle + tesselation flag. </p>
<p>An index pointing into the material table of the shape which instantiates the heightfield. This index determines the material of the lower of the quad's two triangles (i.e. the quad whose upper-left corner is this sample, see the Guide for illustrations).</p>
<p>Special values of the 7 data bits are defined by <a class="el" href="structPxHeightFieldMaterial.html" title="Special material index values for height field samples. ">PxHeightFieldMaterial</a></p>
<p>The tesselation flag specifies which way the quad is split whose upper left corner is this sample. If the flag is set, the diagonal of the quad will run from this sample to the opposite vertex; if not, it will run between the other two vertices (see the Guide for illustrations).</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxHeightFieldGeometry.html" title="Height field geometry class. ">PxHeightFieldGeometry</a> <a class="el" href="structPxHeightFieldSample.html#ae97419cbc1c9fdaa3f7f88fbe2298b1a" title="The triangle material index of the quad&#39;s upper triangle + reserved flag. ">materialIndex1</a> PxShape.setmaterials() <a class="el" href="classPxShape.html#adbaf4b32d62babcbab918fc64d4fcae9" title="Retrieve all the material pointers associated with the shape. ">PxShape.getMaterials()</a> </dd></dl>

</div>
</div>
<a id="ae97419cbc1c9fdaa3f7f88fbe2298b1a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae97419cbc1c9fdaa3f7f88fbe2298b1a">&#9670;&nbsp;</a></span>materialIndex1</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#ga8c8d56ad8584332dc0d55c7936fb0af3">PxBitAndByte</a> PxHeightFieldSample::materialIndex1</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The triangle material index of the quad's upper triangle + reserved flag. </p>
<p>An index pointing into the material table of the shape which instantiates the heightfield. This index determines the material of the upper of the quad's two triangles (i.e. the quad whose upper-left corner is this sample, see the Guide for illustrations).</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxHeightFieldGeometry.html" title="Height field geometry class. ">PxHeightFieldGeometry</a> <a class="el" href="structPxHeightFieldSample.html#a6ec426622c36188a3de6f295caed819f" title="The triangle material index of the quad&#39;s lower triangle + tesselation flag. ">materialIndex0</a> PxShape.setmaterials() <a class="el" href="classPxShape.html#adbaf4b32d62babcbab918fc64d4fcae9" title="Retrieve all the material pointers associated with the shape. ">PxShape.getMaterials()</a> </dd></dl>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="PxHeightFieldSample_8h_source.html">PxHeightFieldSample.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="structPxHeightFieldSample.html">PxHeightFieldSample</a></li>
    <li class="footer">Copyright &copy; 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
  </ul>
</div>
</body>
</html>
